/*
 * Copyright 2011 es-planning Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jp.arctos.ursus.extension.net;

import java.util.Queue;

/**
 * Class for handling asynchronous events from datagram services.
 *
 */
public interface DatagramEventHandler {

    /**
     * Data has been received.
     * 
     * @param sessionHandler Session handler
     * @param context Received context
     */
    void received(DatagramSessionHandler sessionHandler, ReceivedContext context);

    /**
     * Data has finished sending.
     * 
     * @param sessionHandler Session handler
     * @param request Send request queue
     */
    void sent(DatagramSessionHandler sessionHandler, SendRequest request);

    /**
     * Session was closed without using the session handler.
     * 
     * @param sessionHandler Session handler
     * @param queue Send request queue
     */
    void sessionClosed(DatagramSessionHandler sessionHandler, Queue<SendRequest> queue);

    /**
     * Session was closed due to an error.
     * 
     * @param reason Error
     * @param sessionHandler Session handler
     * @param queue Send request queue
     */
    void sessionClosed(Exception reason, DatagramSessionHandler sessionHandler, Queue<SendRequest> queue);
}
